Package-level declarations
Types
Functions
Use this method to close the bot instance before moving it from one local server to another. You need to delete the webhook before calling this method to ensure that the bot isn't launched again after server restart. The method will return error 429 in the first 10 minutes after the bot is launched. Returns True on success. Requires no parameters.
Use this method to create a link for an invoice. Returns the created invoice link as String on success.
Use this method to delete the list of the bot's commands for the given scope and user language. After deletion, higher level commands will be shown to affected users. Returns True on success.
Use this method to remove webhook integration if you decide to switch back to getUpdates. Returns True on success.
Use this method to get information about the connection of the bot with a business account. Returns a BusinessConnection object on success.
A simple method for testing your bot's authentication token. Requires no parameters. Returns basic information about the bot in form of a User object.
Use this method to get the current list of the bot's commands for the given scope and user language. Returns an Array of BotCommand objects. If commands aren't set, an empty list is returned.
Use this method to get the current default administrator rights of the bot. Returns ChatAdministratorRights on success.
Use this method to get the current bot description for the given user language. Returns BotDescription on success.
Use this method to get the current bot name for the given user language. Returns BotName on success.
Use this method to get the current bot short description for the given user language. Returns BotShortDescription on success.
Returns the bot's Telegram Star transactions in chronological order. On success, returns a StarTransactions object.
Use this method to receive incoming updates using long polling (wiki). Returns an Array of Update objects.
Use this method to get current webhook status. Requires no parameters. On success, returns a WebhookInfo object. If the bot is using getUpdates, will return an object with the url field empty.
Use this method to log out from the cloud Bot API server before launching the bot locally. You must log out the bot before running it locally, otherwise there is no guarantee that the bot will receive updates. After a successful call, you can immediately log in on a local server, but will not be able to log in back to the cloud Bot API server for 10 minutes. Returns True on success. Requires no parameters.
Refunds a successful payment in Telegram Stars. Returns True on success.
Use this method to change the list of the bot's commands. See this manual for more details about bot commands. Returns True on success.
Use this method to change the default administrator rights requested by the bot when it's added as an administrator to groups or channels. These rights will be suggested to users, but they are free to modify the list before adding the bot. Returns True on success.
Use this method to change the bot's description, which is shown in the chat with the bot if the chat is empty. Returns True on success.
Use this method to change the bot's name. Returns True on success.
Use this method to change the bot's short description, which is shown on the bot's profile page and is sent together with the link when users share the bot. Returns True on success.
Use this method to specify a URL and receive incoming updates via an outgoing webhook. Whenever there is an update for the bot, we will send an HTTPS POST request to the specified URL, containing a JSON-serialized Update. In case of an unsuccessful request, we will give up after a reasonable amount of attempts. Returns True on success. If you'd like to make sure that the webhook was set by you, you can specify secret data in the parameter secret_token. If specified, the request will contain a header "X-Telegram-Bot-Api-Secret-Token" with the secret token as content.